/*
 *  Copyright (C) 2010 Glauco
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.common;

import java.io.Serializable;

/**
 * Esta é uma interface para repositórios de entidades.<br>
 * Objetos desta interface devem posuir um atributo <code>entity</code> do tipo
 * <code>Serializable</code>.<br>
 * Os objetos devem possuir um PropertyChangeSupport e listeners para ele.
 *
 * @author glauco
 * @see java.beans.PropertyChangeSupport
 */
public interface EntityHolder extends Basic{

    /**
     * Esta propriedade contém o nome do atribuito que armazenará a entidade.
     */
    public static final String PROP_ENTITY = "entity";

    /**
     * Retorna a entidade armazenada
     * @return
     */
    public Serializable getEntity();

    /**
     * Atribui a entidade para armazenar.<br>
     * Deve ser disparado o event o <code>firePropertyChange</code> do
     * <code> PropertyChangeSupport</code> utilizando <code>PROP_ENTITY</code>.
     * @param entity entidade.
     */
    public void setEntity(Serializable entity);

    /**
     * Pega a entidade da propriedade de source e armazena ela neste objeto.
     * @param source Objeto com uma entidade.
     * @param property nome do campo do source com a entidade.
     */
    public void updateFromSource(Serializable source, String property);
}
